Merged
Conversation
…ation next. Signed-off-by: James Ball <jameball@qti.qualcomm.com>
Signed-off-by: James Ball <jameball@qti.qualcomm.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new “params” generation pipeline alongside normative rules tooling, including shared HTML conversion utilities, JSON/YAML schemas, and golden-file tests.
Changes:
- Introduces
tools/create_params.pyto generate params JSON/HTML from normative-rules JSON plus param-def YAML inputs. - Extracts shared AsciiDoc/tag/definition-text HTML conversion into reusable modules (
adoc_to_html.py,def_text_to_html.py,tag_text_to_html.py) and updatescreate_normative_rules.pyto use them. - Adds schemas and golden-file tests for params output and the new HTML conversion helpers; extends
Makefiletest targets accordingly.
Reviewed changes
Copilot reviewed 23 out of 23 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| tools/tag_text_to_html.py | New helper to apply tag-specific display rules on top of shared def-text conversion. |
| tools/def_text_to_html.py | New shared definition-text-to-HTML utilities (tables/newlines/adoc links). |
| tools/create_params.py | New generator for params JSON/HTML plus HTML rendering logic. |
| tools/create_normative_rules.py | Refactors HTML conversion to use shared helper modules. |
| tools/adoc_to_html.py | New shared AsciiDoc formatting conversion implementation (moved out of create_normative_rules). |
| tests/params/test-ch2.yaml | Adds param-def YAML input for chapter Two. |
| tests/params/test-ch1.yaml | Adds param-def YAML input for chapter One. |
| tests/params/expected/test-params.json | Golden expected params JSON output. |
| tests/params/expected/test-params.html | Golden expected params HTML output. |
| tests/norm-rule/test-ch2.yaml | Updates normative-rule test inputs to include impl-def behavior “kind/instance” metadata. |
| tests/norm-rule/test-ch2.adoc | Updates test AsciiDoc anchors/content to exercise HTML conversion behaviors. |
| tests/norm-rule/test-ch1.yaml | Adds impl-def behavior rules to normative-rule test inputs. |
| tests/norm-rule/test-ch1.adoc | Adds impl-def behavior anchor sections and content to exercise tag extraction/conversion. |
| tests/norm-rule/expected/test-norm-rules.json | Updates golden normative-rules JSON output for new impl-def behavior cases/fields. |
| tests/norm-rule/expected/test-norm-rules.html | Updates golden normative-rules HTML output for new impl-def behavior cases/fields. |
| tests/norm-rule/expected/test-ch2-norm-tags.json | Updates golden tag-extraction output for updated chapter 2 anchors/text. |
| tests/norm-rule/expected/test-ch1-norm-tags.json | Updates golden tag-extraction output for added impl-def behavior anchors/tags. |
| tests/adoc2html/test_adoc_to_html.py | Adds isolated regression tests for the new Adoc2HTML converter. |
| schemas/params-schema.json | Adds output schema for params JSON. |
| schemas/param-defs-schema.json | Adds input schema for param-def YAML files. |
| schemas/param-common-schema.json | Adds shared schema fragments for param input/output schemas. |
| schemas/norm-rules-schema.json | Refactors schema to define/reuse a normativeRuleEntry definition. |
| Makefile | Adds params build/compare targets and Adoc2HTML test target into make test. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Signed-off-by: James Ball <jameball@qti.qualcomm.com>
Signed-off-by: James Ball <jameball@qti.qualcomm.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 23 out of 23 changed files in this pull request and generated 6 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: James Ball <jameball@qti.qualcomm.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: James Ball <jameball@qti.qualcomm.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: James Ball <jameball@qti.qualcomm.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: James Ball <jameball@qti.qualcomm.com>
Signed-off-by: James Ball <jameball@qti.qualcomm.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: James Ball <jameball@qti.qualcomm.com>
Signed-off-by: James Ball <jameball@qti.qualcomm.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Added new Python script called create_params.py along with input/output file format schemas and extensive unit-level tests.